Pocketbase Kotlin/io.github.agrevster.pocketbaseKotlin/PocketbaseClient

PocketbaseClient

class PocketbaseClient(baseUrl: <Error class: unknown class>.() -> Unit, lang: String = "en-US", store: BaseAuthStore = BaseAuthStore(null))

A multiplatform Kotlin SDK for Pocketbase

Parameters

baseUrl

the URL of the Pocketbase server

lang

the language of the Pocketbase server

store

the authentication store used to store Pocketbase authentication data

Constructors

PocketbaseClient

constructor(baseUrl: <Error class: unknown class>.() -> Unit, lang: String = "en-US", store: BaseAuthStore = BaseAuthStore(null))

Properties

authStore

var authStore: BaseAuthStore

backups

val backups: BackupsService

The API for Pocketbase backups

baseUrl

val baseUrl: <Error class: unknown class>.() -> Unit

batch

val batch: BatchService

The API for Pocketbase batch

collections

val collections: CollectionService

The API for Pocketbase collections

crons

val crons: CronsService

The API for Pocketbase crons

files

val files: FilesService

The API for Pocketbase files

health

val health: HealthService

The API for Pocketbase health

httpClient

val httpClient: <Error class: unknown class>

The Ktor HttpClient used to connect to the Pocketbase API.

lang

val lang: String

logs

val logs: LogService

The API for Pocketbase logs

realtime

val realtime: RealtimeService

The API for Pocketbase realtime

records

val records: RecordsService

The API for Pocketbase records

settings

val settings: SettingsService

The API for Pocketbase settings

Functions

inline fun PocketbaseClient.login(initialToken: String? = null, setup: TokenLoginBuilder.() -> Unit = {})

Logs into the Pocketbase client with the specified token. This is required before making any API requests that require authentication.

logout

fun PocketbaseClient.logout()

Clears the current auth token from the auth store.